home *** CD-ROM | disk | FTP | other *** search
/ Chip 2007 January, February, March & April / Chip-Cover-CD-2007-02.iso / Pakiet internetowy / Przegladarki internetowe / Mozilla Seamonkey 1.0.5 pl / seamonkey-1.0.5.pl-PL.win32.installer.exe / BROWSER.XPI / bin / components / nsSidebar.js < prev    next >
Encoding:
Text File  |  2006-09-10  |  17.7 KB  |  461 lines
  1. /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
  2.  * ***** BEGIN LICENSE BLOCK *****
  3.  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
  4.  *
  5.  * The contents of this file are subject to the Mozilla Public License Version
  6.  * 1.1 (the "License"); you may not use this file except in compliance with
  7.  * the License. You may obtain a copy of the License at
  8.  * http://www.mozilla.org/MPL/
  9.  *
  10.  * Software distributed under the License is distributed on an "AS IS" basis,
  11.  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  12.  * for the specific language governing rights and limitations under the
  13.  * License.
  14.  *
  15.  * The Original Code is mozilla.org code.
  16.  *
  17.  * The Initial Developer of the Original Code is
  18.  * Netscape Communications Corporation.
  19.  * Portions created by the Initial Developer are Copyright (C) 1999
  20.  * the Initial Developer. All Rights Reserved.
  21.  *
  22.  * Contributor(s):
  23.  *   Stephen Lamm            <slamm@netscape.com>
  24.  *   Robert John Churchill   <rjc@netscape.com>
  25.  *
  26.  * Alternatively, the contents of this file may be used under the terms of
  27.  * either of the GNU General Public License Version 2 or later (the "GPL"),
  28.  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  29.  * in which case the provisions of the GPL or the LGPL are applicable instead
  30.  * of those above. If you wish to allow use of your version of this file only
  31.  * under the terms of either the GPL or the LGPL, and not to allow others to
  32.  * use your version of this file under the terms of the MPL, indicate your
  33.  * decision by deleting the provisions above and replace them with the notice
  34.  * and other provisions required by the GPL or the LGPL. If you do not delete
  35.  * the provisions above, a recipient may use your version of this file under
  36.  * the terms of any one of the MPL, the GPL or the LGPL.
  37.  *
  38.  * ***** END LICENSE BLOCK ***** */
  39.  
  40. /*
  41.  * No magic constructor behaviour, as is de rigeur for XPCOM.
  42.  * If you must perform some initialization, and it could possibly fail (even
  43.  * due to an out-of-memory condition), you should use an Init method, which
  44.  * can convey failure appropriately (thrown exception in JS,
  45.  * NS_FAILED(nsresult) return in C++).
  46.  *
  47.  * In JS, you can actually cheat, because a thrown exception will cause the
  48.  * CreateInstance call to fail in turn, but not all languages are so lucky.
  49.  * (Though ANSI C++ provides exceptions, they are verboten in Mozilla code
  50.  * for portability reasons -- and even when you're building completely
  51.  * platform-specific code, you can't throw across an XPCOM method boundary.)
  52.  */
  53.  
  54. const DEBUG = false; /* set to false to suppress debug messages */
  55. const PANELS_RDF_FILE  = "UPnls"; /* directory services property to find panels.rdf */
  56.  
  57. const SIDEBAR_CONTRACTID   = "@mozilla.org/sidebar;1";
  58. const SIDEBAR_CID      = Components.ID("{22117140-9c6e-11d3-aaf1-00805f8a4905}");
  59. const CONTAINER_CONTRACTID = "@mozilla.org/rdf/container;1";
  60. const DIR_SERV_CONTRACTID  = "@mozilla.org/file/directory_service;1"
  61. const NETSEARCH_CONTRACTID = "@mozilla.org/rdf/datasource;1?name=internetsearch"
  62. const IO_SERV_CONTRACTID   = "@mozilla.org/network/io-service;1";
  63. const nsISupports      = Components.interfaces.nsISupports;
  64. const nsIFactory       = Components.interfaces.nsIFactory;
  65. const nsISidebar       = Components.interfaces.nsISidebar;
  66. const nsIRDFContainer  = Components.interfaces.nsIRDFContainer;
  67. const nsIProperties    = Components.interfaces.nsIProperties;
  68. const nsIFileURL       = Components.interfaces.nsIFileURL;
  69. const nsIRDFRemoteDataSource = Components.interfaces.nsIRDFRemoteDataSource;
  70. const nsIInternetSearchService = Components.interfaces.nsIInternetSearchService;
  71. const nsIClassInfo = Components.interfaces.nsIClassInfo;
  72.  
  73. function nsSidebar()
  74. {
  75.     const RDF_CONTRACTID = "@mozilla.org/rdf/rdf-service;1";
  76.     const nsIRDFService = Components.interfaces.nsIRDFService;
  77.  
  78.     this.rdf = Components.classes[RDF_CONTRACTID].getService(nsIRDFService);
  79.     this.datasource_uri = getSidebarDatasourceURI(PANELS_RDF_FILE);
  80.     debug('datasource_uri is ' + this.datasource_uri);
  81.     this.resource = 'urn:sidebar:current-panel-list';
  82.     this.datasource = this.rdf.GetDataSource(this.datasource_uri);
  83.  
  84.     const PROMPTSERVICE_CONTRACTID = "@mozilla.org/embedcomp/prompt-service;1";
  85.     const nsIPromptService = Components.interfaces.nsIPromptService;
  86.     this.promptService =
  87.         Components.classes[PROMPTSERVICE_CONTRACTID].getService(nsIPromptService);
  88. }
  89.  
  90. nsSidebar.prototype.nc = "http://home.netscape.com/NC-rdf#";
  91.  
  92. nsSidebar.prototype.isPanel =
  93. function (aContentURL)
  94. {
  95.     var container =
  96.         Components.classes[CONTAINER_CONTRACTID].createInstance(nsIRDFContainer);
  97.  
  98.     container.Init(this.datasource, this.rdf.GetResource(this.resource));
  99.  
  100.     /* Create a resource for the new panel and add it to the list */
  101.     var panel_resource =
  102.         this.rdf.GetResource("urn:sidebar:3rdparty-panel:" + aContentURL);
  103.  
  104.     return (container.IndexOf(panel_resource) != -1);
  105. }
  106.  
  107. function sidebarURLSecurityCheck(url)
  108. {
  109.     if (!/(^http:|^ftp:|^https:)/i.test(url))
  110.         throw "Script attempted to add sidebar panel from illegal source";
  111. }
  112.  
  113. /* decorate prototype to provide ``class'' methods and property accessors */
  114. nsSidebar.prototype.addPanel =
  115. function (aTitle, aContentURL, aCustomizeURL)
  116. {
  117.     debug("addPanel(" + aTitle + ", " + aContentURL + ", " +
  118.           aCustomizeURL + ")");
  119.  
  120.     return this.addPanelInternal(aTitle, aContentURL, aCustomizeURL, false);
  121. }
  122.  
  123. nsSidebar.prototype.addPersistentPanel =
  124. function(aTitle, aContentURL, aCustomizeURL)
  125. {
  126.     debug("addPersistentPanel(" + aTitle + ", " + aContentURL + ", " +
  127.            aCustomizeURL + ")\n");
  128.  
  129.     return this.addPanelInternal(aTitle, aContentURL, aCustomizeURL, true);
  130. }
  131.  
  132. nsSidebar.prototype.addPanelInternal =
  133. function (aTitle, aContentURL, aCustomizeURL, aPersist)
  134. {
  135.     sidebarURLSecurityCheck(aContentURL);
  136.  
  137.     // Create a "container" wrapper around the current panels to
  138.     // manipulate the RDF:Seq more easily.
  139.     var panel_list = this.datasource.GetTarget(this.rdf.GetResource(this.resource), this.rdf.GetResource(nsSidebar.prototype.nc+"panel-list"), true);
  140.     if (panel_list) {
  141.         panel_list.QueryInterface(Components.interfaces.nsIRDFResource);
  142.     } else {
  143.         // Datasource is busted. Start over.
  144.         debug("Sidebar datasource is busted\n");
  145.     }
  146.  
  147.     var container = Components.classes[CONTAINER_CONTRACTID].createInstance(nsIRDFContainer);
  148.     container.Init(this.datasource, panel_list);
  149.  
  150.     /* Create a resource for the new panel and add it to the list */
  151.     var panel_resource =
  152.         this.rdf.GetResource("urn:sidebar:3rdparty-panel:" + aContentURL);
  153.     var panel_index = container.IndexOf(panel_resource);
  154.     var stringBundle, brandStringBundle, titleMessage, dialogMessage;
  155.     if (panel_index != -1)
  156.     {
  157.         try {
  158.             stringBundle = srGetStrBundle("chrome://communicator/locale/sidebar/sidebar.properties");
  159.             brandStringBundle = srGetStrBundle("chrome://branding/locale/brand.properties");
  160.             if (stringBundle) {
  161.                 sidebarName = brandStringBundle.GetStringFromName("sidebarName");
  162.                 titleMessage = stringBundle.GetStringFromName("dupePanelAlertTitle");
  163.                 dialogMessage = stringBundle.GetStringFromName("dupePanelAlertMessage");
  164.                 dialogMessage = dialogMessage.replace(/%url%/, aContentURL);
  165.                 dialogMessage = dialogMessage.replace(/%name%/, sidebarName);
  166.             }
  167.         }
  168.         catch (e) {
  169.             titleMessage = "Sidebar";
  170.             dialogMessage = aContentURL + " already exists in Sidebar.  No string bundle";
  171.         }
  172.  
  173.         this.promptService.alert(null, titleMessage, dialogMessage);
  174.  
  175.         return;
  176.     }
  177.  
  178.     try {
  179.         stringBundle = srGetStrBundle("chrome://communicator/locale/sidebar/sidebar.properties");
  180.         brandStringBundle = srGetStrBundle("chrome://branding/locale/brand.properties");
  181.         if (stringBundle) {
  182.             sidebarName = brandStringBundle.GetStringFromName("sidebarName");
  183.             titleMessage = stringBundle.GetStringFromName("addPanelConfirmTitle");
  184.             dialogMessage = stringBundle.GetStringFromName("addPanelConfirmMessage");
  185.             if (aPersist)
  186.             {
  187.                 var warning = stringBundle.GetStringFromName("persistentPanelWarning");
  188.                 dialogMessage += "\n" + warning;
  189.             }
  190.             dialogMessage = dialogMessage.replace(/%title%/, aTitle);
  191.             dialogMessage = dialogMessage.replace(/%url%/, aContentURL);
  192.             dialogMessage = dialogMessage.replace(/#/g, "\n");
  193.             dialogMessage = dialogMessage.replace(/%name%/g, sidebarName);
  194.         }
  195.     }
  196.     catch (e) {
  197.         titleMessage = "Add Tab to Sidebar";
  198.         dialogMessage = "No string bundle.  Add the Tab '" + aTitle + "' to Sidebar?\n\n" + "Source: " + aContentURL;
  199.     }
  200.  
  201.     var rv = this.promptService.confirm(null, titleMessage, dialogMessage);
  202.  
  203.     if (!rv)
  204.         return;
  205.  
  206.     /* Now make some sidebar-ish assertions about it... */
  207.     this.datasource.Assert(panel_resource,
  208.                            this.rdf.GetResource(this.nc + "title"),
  209.                            this.rdf.GetLiteral(aTitle),
  210.                            true);
  211.     this.datasource.Assert(panel_resource,
  212.                            this.rdf.GetResource(this.nc + "content"),
  213.                            this.rdf.GetLiteral(aContentURL),
  214.                            true);
  215.     if (aCustomizeURL)
  216.         this.datasource.Assert(panel_resource,
  217.                                this.rdf.GetResource(this.nc + "customize"),
  218.                                this.rdf.GetLiteral(aCustomizeURL),
  219.                                true);
  220.     var persistValue = aPersist ? "true" : "false";
  221.     this.datasource.Assert(panel_resource,
  222.                            this.rdf.GetResource(this.nc + "persist"),
  223.                            this.rdf.GetLiteral(persistValue),
  224.                            true);
  225.  
  226.     container.AppendElement(panel_resource);
  227.  
  228.     // Use an assertion to pass a "refresh" event to all the sidebars.
  229.     // They use observers to watch for this assertion (in sidebarOverlay.js).
  230.     this.datasource.Assert(this.rdf.GetResource(this.resource),
  231.                            this.rdf.GetResource(this.nc + "refresh"),
  232.                            this.rdf.GetLiteral("true"),
  233.                            true);
  234.     this.datasource.Unassert(this.rdf.GetResource(this.resource),
  235.                              this.rdf.GetResource(this.nc + "refresh"),
  236.                              this.rdf.GetLiteral("true"));
  237.  
  238.     /* Write the modified panels out. */
  239.     this.datasource.QueryInterface(nsIRDFRemoteDataSource).Flush();
  240.  
  241. }
  242.  
  243. /* decorate prototype to provide ``class'' methods and property accessors */
  244. nsSidebar.prototype.addSearchEngine =
  245. function (engineURL, iconURL, suggestedTitle, suggestedCategory)
  246. {
  247.     debug("addSearchEngine(" + engineURL + ", " + iconURL + ", " +
  248.           suggestedCategory + ", " + suggestedTitle + ")");
  249.  
  250.     try
  251.     {
  252.         // make sure using HTTP or HTTPS and refering to a .src file
  253.         // for the engine.
  254.         if (! /^https?:\/\/.+\.src$/i.test(engineURL))
  255.             throw "Unsupported search engine URL";
  256.  
  257.         // make sure using HTTP or HTTPS and refering to a
  258.         // .gif/.jpg/.jpeg/.png file for the icon.
  259.         if (! /^https?:\/\/.+\.(gif|jpg|jpeg|png)$/i.test(iconURL))
  260.             throw "Unsupported search icon URL";
  261.     }
  262.     catch(ex)
  263.     {
  264.         debug(ex);
  265.         this.promptService.alert(null, "Error", "Failed to add the search engine.");
  266.         throw Components.results.NS_ERROR_INVALID_ARG;
  267.     }
  268.  
  269.     var titleMessage, dialogMessage;
  270.     try {
  271.         var stringBundle = srGetStrBundle("chrome://communicator/locale/sidebar/sidebar.properties");
  272.         var brandStringBundle = srGetStrBundle("chrome://branding/locale/brand.properties");
  273.         if (stringBundle) {
  274.             sidebarName = brandStringBundle.GetStringFromName("sidebarName");
  275.             titleMessage = stringBundle.GetStringFromName("addEngineConfirmTitle");
  276.             dialogMessage = stringBundle.GetStringFromName("addEngineConfirmMessage");
  277.             dialogMessage = dialogMessage.replace(/%title%/, suggestedTitle);
  278.             dialogMessage = dialogMessage.replace(/%category%/, suggestedCategory);
  279.             dialogMessage = dialogMessage.replace(/%url%/, engineURL);
  280.             dialogMessage = dialogMessage.replace(/#/g, "\n");
  281.             dialogMessage = dialogMessage.replace(/%name%/, sidebarName);
  282.         }
  283.     }
  284.     catch (e) {
  285.         titleMessage = "Add Search Engine";
  286.         dialogMessage = "Add the following search engine?\n\nName: " + suggestedTitle;
  287.         dialogMessage += "\nSearch Category: " + suggestedCategory;
  288.         dialogMessage += "\nSource: " + engineURL;
  289.     }
  290.  
  291.     var rv = this.promptService.confirm(null, titleMessage, dialogMessage);
  292.  
  293.     if (!rv)
  294.         return;
  295.  
  296.     var internetSearch = Components.classes[NETSEARCH_CONTRACTID].getService();
  297.     if (internetSearch)
  298.         internetSearch = internetSearch.QueryInterface(nsIInternetSearchService);
  299.     if (internetSearch)
  300.     {
  301.         internetSearch.AddSearchEngine(engineURL, iconURL, suggestedTitle,
  302.                                        suggestedCategory);
  303.     }
  304. }
  305.  
  306. // property of nsIClassInfo
  307. nsSidebar.prototype.flags = nsIClassInfo.DOM_OBJECT;
  308.  
  309. // property of nsIClassInfo
  310. nsSidebar.prototype.classDescription = "Sidebar";
  311.  
  312. // method of nsIClassInfo
  313. nsSidebar.prototype.getInterfaces = function(count) {
  314.     var interfaceList = [nsISidebar, nsIClassInfo];
  315.     count.value = interfaceList.length;
  316.     return interfaceList;
  317. }
  318.  
  319. // method of nsIClassInfo
  320. nsSidebar.prototype.getHelperForLanguage = function(count) {return null;}
  321.  
  322. nsSidebar.prototype.QueryInterface =
  323. function (iid) {
  324.     if (iid.equals(nsISidebar) ||
  325.         iid.equals(nsIClassInfo) ||
  326.         iid.equals(nsISupports))
  327.         return this;
  328.  
  329.     Components.returnCode = Components.results.NS_ERROR_NO_INTERFACE;
  330.     return null;
  331. }
  332.  
  333. var sidebarModule = new Object();
  334.  
  335. sidebarModule.registerSelf =
  336. function (compMgr, fileSpec, location, type)
  337. {
  338.     debug("registering (all right -- a JavaScript module!)");
  339.     compMgr = compMgr.QueryInterface(Components.interfaces.nsIComponentRegistrar);
  340.  
  341.     compMgr.registerFactoryLocation(SIDEBAR_CID,
  342.                                     "Sidebar JS Component",
  343.                                     SIDEBAR_CONTRACTID,
  344.                                     fileSpec,
  345.                                     location,
  346.                                     type);
  347.  
  348.     const CATMAN_CONTRACTID = "@mozilla.org/categorymanager;1";
  349.     const nsICategoryManager = Components.interfaces.nsICategoryManager;
  350.     var catman = Components.classes[CATMAN_CONTRACTID].
  351.                             getService(nsICategoryManager);
  352.  
  353.     const JAVASCRIPT_GLOBAL_PROPERTY_CATEGORY = "JavaScript global property";
  354.     catman.addCategoryEntry(JAVASCRIPT_GLOBAL_PROPERTY_CATEGORY,
  355.                             "sidebar",
  356.                             SIDEBAR_CONTRACTID,
  357.                             true,
  358.                             true);
  359. }
  360.  
  361. sidebarModule.getClassObject =
  362. function (compMgr, cid, iid) {
  363.     if (!cid.equals(SIDEBAR_CID))
  364.         throw Components.results.NS_ERROR_NO_INTERFACE;
  365.  
  366.     if (!iid.equals(Components.interfaces.nsIFactory))
  367.         throw Components.results.NS_ERROR_NOT_IMPLEMENTED;
  368.  
  369.     return sidebarFactory;
  370. }
  371.  
  372. sidebarModule.canUnload =
  373. function(compMgr)
  374. {
  375.     debug("Unloading component.");
  376.     return true;
  377. }
  378.  
  379. /* factory object */
  380. var sidebarFactory = new Object();
  381.  
  382. sidebarFactory.createInstance =
  383. function (outer, iid) {
  384.     debug("CI: " + iid);
  385.     if (outer != null)
  386.         throw Components.results.NS_ERROR_NO_AGGREGATION;
  387.  
  388.     return (new nsSidebar()).QueryInterface(iid);
  389. }
  390.  
  391. /* entrypoint */
  392. function NSGetModule(compMgr, fileSpec) {
  393.     return sidebarModule;
  394. }
  395.  
  396. /* static functions */
  397. if (DEBUG)
  398.     debug = function (s) { dump("-*- sidebar component: " + s + "\n"); }
  399. else
  400.     debug = function (s) {}
  401.  
  402. function getSidebarDatasourceURI(panels_file_id)
  403. {
  404.     try
  405.     {
  406.         /* use the fileLocator to look in the profile directory
  407.          * to find 'panels.rdf', which is the
  408.          * database of the user's currently selected panels. */
  409.         var directory_service = Components.classes[DIR_SERV_CONTRACTID].getService(Components.interfaces.nsIProperties);
  410.  
  411.         /* if <profile>/panels.rdf doesn't exist, get will copy
  412.          *bin/defaults/profile/panels.rdf to <profile>/panels.rdf */
  413.         var sidebar_file = directory_service.get(panels_file_id, Components.interfaces.nsIFile);
  414.  
  415.         if (!sidebar_file.exists())
  416.         {
  417.             /* this should not happen, as GetFileLocation() should copy
  418.              * defaults/panels.rdf to the users profile directory */
  419.             debug("sidebar file does not exist");
  420.             return null;
  421.         }
  422.  
  423.         var io_service = Components.classes[IO_SERV_CONTRACTID].getService(Components.interfaces.nsIIOService);
  424.         var file_handler = io_service.getProtocolHandler("file").QueryInterface(Components.interfaces.nsIFileProtocolHandler);
  425.         var sidebar_uri = file_handler.getURLSpecFromFile(sidebar_file);
  426.         debug("sidebar uri is " + sidebar_uri);
  427.         return sidebar_uri;
  428.     }
  429.     catch (ex)
  430.     {
  431.         /* this should not happen */
  432.         debug("caught " + ex + " getting sidebar datasource uri");
  433.         return null;
  434.     }
  435. }
  436.  
  437.  
  438. var strBundleService = null;
  439. function srGetStrBundle(path)
  440. {
  441.    var strBundle = null;
  442.    if (!strBundleService) {
  443.        try {
  444.           strBundleService =
  445.           Components.classes["@mozilla.org/intl/stringbundle;1"].getService();
  446.           strBundleService =
  447.           strBundleService.QueryInterface(Components.interfaces.nsIStringBundleService);
  448.        } catch (ex) {
  449.           dump("\n--** strBundleService failed: " + ex + "\n");
  450.           return null;
  451.       }
  452.    }
  453.    strBundle = strBundleService.createBundle(path);
  454.    if (!strBundle) {
  455.        dump("\n--** strBundle createInstance failed **--\n");
  456.    }
  457.    return strBundle;
  458. }
  459.  
  460.  
  461.